Data Groups
With few exceptions, data groups must be defined in a device template file (DTF) in order for them to be available for use on a remote device. Which data groups are defined by a device template file depends on protocol, device type, and unique configuration.
CygNet distributes sample device template files for its EIEs, each of which typically serves one or more hardware models along with applicable firmware. Therefore, the data groups described below are only those data groups defined by CygNet in sample device template file(s). Your template(s) might not include some of the data groups described below. Device template files exist to enable users to customize device configurations; however, CygNet is not responsible for changes made by users.
For information about data group definitions and device template files, see Device Template Files.
For more information about data group dependencies, see Data Group Dependencies.
Notes:
- Modbus data groups can be added to or modified in a device template file. Modbus data groups are identified by the dgProtcol attribute (dgProtocol="Modbus"). New native data groups cannot be added. Native data groups can be deleted if no other data groups depend upon them and they are otherwise unneeded. However, deleting native data groups is not advised. Native data groups are identified by the dgProtocol attribute (dgProtocol="Internal" or dgProtocol="Native"). Not all elements are supported by native messaging. Elements listed in a Modbus data group are not necessarily included in a data group of the same name in a native template. dgProtocol enables a driver to understand how to construct the appropriate message. Value options are "Internal" or "Native" for a data group that must be read as non-Modbus and "Modbus" for a data group that must be read as Modbus. Do not modify this attribute from its existing state in the relevant sample device template files.
-
When point processing is performed on history data groups, only closed records will be published and processed to points. If a device has leading timestamped records and returns the current, open record, point processing will not be performed for that record, even though there is data in the DDS transaction. The point record will be updated only when that record is closed. This is to avoid a situation where a point has multiple entries with the same timestamp, since an open record may be still updating values with each new poll, but each update will have the same timestamp. For example, say you start polling for a daily history record at 8:00am, you’ll get the first value at 8:00am, then if you poll every five minutes, you’ll get new values throughout the day at the exact same timestamp. A history record is basically an array of data with a timestamp and values where the values have different process variables for each incremental poll. The timestamp won’t get written until the record is closed, which happens at the end of the time period, in this case, a day.
-
Best practice recommends that you do not perform UDC and point processing on FMS data groups. The DEIDs specified in FMS data groups are generic and use the eFMS enumeration to identify the CygNet-defined FMS items referenced in the device template file. No polling is done on these data groups — all data is coming from the native data groups. Points should be mapped to the native data groups since that is the data group that is actually processing the device data. While point processing may work on the FMS data groups, it is not supported, not tested, not consistent across EIEs, and is not recommended practice.
Flow Auto EIE Data Groups
Browse by letter: [A] [C] [D] [E] [F] [G] [H] [I] [M] [P] [R] [S] [T] [U] [W]
| Data Group Type | Usage Notes |
|---|---|
|
"Alarm Trail" retrieves a list of all alarm events for a user-specified time window. See the relevant Flow Automation protocol for a list of alarm codes. The Run field reflects the index of the relevant meter run. For instance, a 0 in the Run field indicates meter run 1. A Run value of 255 indicates that the alarm applies to all configured meter runs. |
|
|
"Historical Analog Config" retrieves, displays, and edits historical configuration data for up to four analog/pulse inputs per data group. Requires function type 11 — Analog History. See also "Historical Analog Data" and Function Type to Data Group Mapping. |
|
|
"Historical Analog Data" retrieves and displays historical analog/pulse data for the corresponding "Historical Analog Config" data group ordinal and analog inputs. Requires function type 11 — Analog History. See Historical Analog Config and Function Type to Data Group Mapping. |
|
|
"Audit Trail" retrieves a list of all configuration change events for a user-specified time window. |
|
|
The "Composite Data Group" is a special kind of data group that enables you to combine any data group element(s) from any data group(s) as long as they are in the same template as the composite data group. The "Composite Data Group" does not appear in a remote device editor unless it has been defined in the relevant device template file. See Composite Data Group. |
|
|
"Date/Time" retrieves the field device's current time and can be used to sync it to the host's current time. |
|
|
DCParms |
"Drip Control Parms (native)" retrieves numerous configuration items relevant to drip control. Requires function type 6 — Drip Control. See also Function Type to Data Group Mapping. |
|
"Ext Static Flow Parms" Retrieves, displays, and edits extended static flow factor parameters. |
|
|
"Flow Plunger Cycle History" retrieves and displays flow plunger cycle history for a given time span. A field device must be manually configured for use with one or more flow plungers in order for this data group to work. Requires function type 21 — Flow Plunger. See also Function Type to Data Group Mapping. |
|
|
FlowPLInst |
"Flow Plunger Lift Data" retrieves and displays flow plunger lift data. A field device must be manually configured for use with one or more flow plungers in order for this data group to work. Requires function type 21 — Flow Plunger. See also Function Type to Data Group Mapping. |
|
FlowPLPrms |
"Flow Plunger Lift Parms" enables you to retrieve, display, and edit flow plunger lift parameters. A field device must be manually configured for use with one or more flow plungers in order for this data group to work. Requires function type 21 — Flow Plunger. See also Function Type to Data Group Mapping. |
|
FlowPLSumm |
"Flow Plunger Summary" retrieves and displays a summary of flow plunger operational data. A field device must be manually configured for use with one or more flow plungers in order for this data group to work. Requires function type 21 — Flow Plunger. See also Function Type to Data Group Mapping. |
|
"FMS Alarms" Dependencies:
|
|
|
FmsConfig |
"FMS Configuration" is required for use with CygNet Measurement. FMS data group units displayed in the DDS reflect their points of origin. "FMS Configuration" must be retrieved before polling other FMS data groups of the same ordinal. The Flow Automation driver includes options on the "FMS Configuration" Data Group Properties dialog box that enable a user to specify one of three ways to retrieve Gas Quality data:
If you choose to retrieve gas quality data, you must add the "Gas Analysis (native)" data group. This data group supports send/write functionality. However, sends can only be initiated from FMS. If you are using AutoSCAN, see also Unit Configuration Data. Dependencies:
|
|
"FMS Events" Dependencies:
|
|
|
Although "FMS Daily PM History" has no dependencies, poll "RTU Config" first. |
|
|
"FMS Daily PQ History" Dependencies:
|
|
|
Although "FMS Hourly PM History" has no dependencies, poll "RTU Config" first. |
|
|
"FMS Hourly PQ History" Dependencies:
|
|
|
"Gas Analysis (native)" retrieves, displays, and edits gas component percentages. Required for retrieval of gas quality with the "FMS Configuration" data group. |
|
|
"History" retrieves and displays relevant history on a daily or hourly basis for each configured meter run. Each instance of this data group can retrieve and display hourly or daily history. Despite being part of the same data group, hourly and daily history are treated as unique entities. That means that each uses its own host-side cache. For example, using the optimized method to retrieve hourly history does not affect the retrieval of daily history. |
|
|
"Instant Data (native)" retrieves and displays instantaneous data on a per meter run basis for the relevant meter type (orifice, stacked orifice, turbine, and so forth). |
|
|
"Manual Plunger Lift Data" retrieves and displays manual plunger lift data. A field device must be manually configured for use with one or more manual plungers in order for this data group to work. Requires function type 13 — Manual Plunger or 20 — Manual Plunger, depending on customer code as listed in the software ID (i.e., firmware). See also Function Type to Data Group Mapping. |
|
|
ManPLPrms |
"Manual Plunger Lift Parms" retrieves and displays manual plunger lift parameters. A field device must be manually configured for use with one or more manual plungers in order for this data group to work. Requires function type 13 — Manual Plunger or 20 — Manual Plunger, depending on customer code as listed in the software ID (i.e., firmware). See also Function Type to Data Group Mapping. |
|
MinHstData |
"Historical Minute Data" retrieves and displays historical variable data relevant to a flow plunger. Requires function type 21 — Flow Plunger. See Function Type to Data Group Mapping. |
|
"Password Table" retrieves, displays, and edits user-defined passwords for several types of device access. |
|
|
PIDParms |
"PID Parms (native)" retrieves and displays PID parameters. Requires function type 9 — PID or 16 — PID, depending on customer code as listed in the software ID (i.e., firmware). See also Function Type to Data Group Mapping. |
|
PLInst |
"Auto Plunger Lift Data (native)" retrieves numerous data values relevant to the use of an auto plunger. Requires function type 12 — Auto Plunger. See also Function Type to Data Group Mapping. |
|
PLParms |
"Auto Plunger Lift Parms (native)" retrieves numerous configuration items relevant to an auto plunger. Requires function type 12 — Auto Plunger. See also Function Type to Data Group Mapping. |
|
PntRecAI |
"Point Rec AI" retrieves and displays data relevant to the specified analog input point. You do not need to add this data group to view its data. Instead, you can access the point data from the "Point List" data group. See Point List. |
|
PntRecAO |
"Point Rec AO" retrieves and displays data relevant to the specified analog output point. You do not need to add this data group to view or edit its data. Instead, you can access the point data from the "Point List" data group. See Point List. |
|
PntRecDI |
"Point Rec DI" retrieves and displays data relevant to the specified discrete input point. You do not need to add this data group to view its data. Instead, you can access the point data from the "Point List" data group. See Point List. |
|
PntRecDO |
"Point Rec DO" retrieves and displays data relevant to the specified discrete output point. You do not need to add this data group to view or edit its data. Instead, you can access the point data from the "Point List" data group. See Point List. |
|
PntRecPI |
"Point Rec PI" retrieves and displays data relevant to the specified pulse input point. You do not need to add this data group to view its data. Instead, you can access the point data from the "Point List" data group. See Point List. |
|
"Point List" displays all input and output points for connected field devices. Exists only for navigation purposes; no RTU messaging occurs with this data group. Controls are available to display the individual input and output points. |
|
|
A valid "RTU Config" data group must be retrieved before other data groups can be retrieved or sent. This data group lists all connected meter runs and their types as well as all function types for which the field device is configured. Not all function types are supported by CygNet. Meters and function types must be configured at the field device, not using CygNet. See Function Type to Data Group Mapping. Unit Type values are as follows:
The Software ID field indicates the equivalent of the field device's firmware. From left to right, positions one and two indicate unit type (for instance, AM, AP, and SF), positions three and four indicate the major revision number, positions five and six indicate the customer code (for instance, CO, DV, EG, and MB), and positions seven and eight indicate the minor revision number. For instance, AP22MB1C. |
|
|
"Stat Parms (native)" retrieves, displays, and edits relevant static parameters on a meter run basis for the relevant meter type (orifice, stacked orifice, turbine, and so forth). See also Measurement Units. |
|
|
StatParms2 |
"Stat Parms 2 (native)" does not work with CO (Coastal) firmware. |
|
"System Parms (native)" retrieves and displays various system-level parameters. EngUnits values are as follows:
|
|
|
"Tank Function" retrieves and displays various tank gauge parameters. Requires function type 12 — Tank Gauge or 14 — Tank Gauge, depending on customer code. See Function Type to Data Group Mapping. |
|
|
TnkOff |
"Tank Gauge Offsets" retrieves and displays tank gauge offsets. Requires function type 12 — Tank Gauge or 14 — Tank Gauge, depending on customer code. See Function Type to Data Group Mapping. |
|
TnkSenCfg |
"Tank Sensor Configuration" retrieves, displays, and edits tank sensor configuration parameters. When adding this data group, you must assign it to the correct Tank Function #, Gauge #, and Sensor #. Doing so generates its unique ordinal. Requires function type 12 — Tank Gauge or 14 — Tank Gauge, depending on customer code. See Function Type to Data Group Mapping. |
|
TnkSenInst |
"Tank Sensor Instantaneous Data" retrieves, displays, and edits tank sensor instantaneous data. When adding this data group, you must assign it to the correct Tank Function #, Gauge #, and Sensor #. Doing so generates its unique ordinal. Requires function type 12 — Tank Gauge or 14 — Tank Gauge, depending on customer code. See Function Type to Data Group Mapping. |
|
"Unit Configuration Data" retrieves basic configuration data about the connected field device (i.e., unit), including meter type information. This data group can only be retrieved if an instance of the data group exists on the remote device. If it exists, it is included as part of the "RTU Config" message chain; however, in some special cases it is not required. If you do not require it (for instance, because it conflicts with AutoSCAN functionality), delete the data group from the CygNet remote device. Deletion of this data group is not typical. This data group is required if you are using cone meters. Without it, a cone meter incorrectly displays as an orifice meter in various data groups or provides incorrect data. This data group is required if you are using the "FMS Configuration" data group. It provides "FMS Configuration" with the analog input information that is used to retrieve high and low alarm limits for differential pressure, static pressure, and temperature. |
|
|
"Write Analog Output" edits analog output value for the specified analog output point. See Point List. |
|
|
"Write Discrete Output" edits discrete output value for the specified discrete output point. See Point List. |
